如何写好 GitHub README

2023年底，我在公司里研发的 Unify 项目成功通过外部开源审核，成为代表公司的 Github 开源项目之一。

很快我便意识到，将代码开放出去，就像一颗破土而出的种子，面对广阔的天地，这仅仅是一个开始。

第一个问题立刻来到，如何把项目的 README 写好，让公司外的人轻松了解项目内容，认可项目价值。我们修改了很多版，但我依旧不满意。

因此，在本文中，我对 GitHub 上流行的项目进行研究，总结他们的优秀经验，帮助我把这个 README 写好。

篇章结构

典型的篇章结构如下：

• Introduction：
  • 简短的项目介绍
• Installation
  • 快速安装使用
• Getting Started：
  • 或者快速将 Example 跑起来
• Usage
  • 更加详细的使用方式
• How to Contribute
  • 开发者如何参与其中

最后，可以加一个 star 历史曲线。

出彩的 Introduction

首先把 Logo 居中展示。

接下来是用标题给出项目名称，以及一句简短口号。

接下来是一对标签，包括协议、pub.dev、ci 状态……

接下来是主体介绍内容，回答 What、Why。

注意篇幅要短，可以留一个链接，连入详细介绍中。

本文作者：Maeiee

本文链接：如何写好 GitHub README

版权声明：如无特别声明，本文即为原创文章，版权归 Maeiee 所有，未经允许不得转载！

喜欢我文章的朋友请随缘打赏，鼓励我创作更多更好的作品！